<?php
/**
 * This file houses the JsonOutputProtocol class.
 *
 * Copyright (c) 2010, Kalkomey Enterprises, Inc.
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, this 
 *   list of conditions and the following disclaimer in the documentation and/or other
 *   materials provided with the distribution.
 * - Neither the name of the Kalkomey Enterprises, Inc. nor the names of its 
 *   contributors may be used to endorse or promote products derived from this 
 *   software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * @license http://www.opensource.org/licenses/bsd-license.php New BSD License
 * @copyright Copyright (c) 2010, Kalkomey Enterprises, Inc.
 * @link http://code.google.com/p/swerv/
 * @package Shared
 * @subpackage Protocols
 */

/**
 * The JsonOutputProtocol class converts a response object into JSON.
 *
 * @package Shared
 * @subpackage Protocols
 */
class JsonOutputProtocol extends OutputProtocol {
	
	/**
	 * Converts a response object into JSON.
	 *
	 * @uses JsonOutputProtocol::makeStandardObj()
	 *
	 * @return string
	 */
	public function getOutput(&$responseObj) {
		$plainObj = new stdClass();
		$this->makeStandardObj($plainObj, $responseObj);
		return json_encode($plainObj);
	}
	
	/**
	 * Converts an object from a response object into a stdClass() object.  This is needed primarily because of database model objects which store properties in arrays instead of individual property variables.
	 * Note: this is a recursive method.
	 *
	 * @param object &$plainObj the object being converted to
	 * @param object &$complexObj the object being converted
	 *
	 * @return void
	 */
	private function makeStandardObj(&$plainObj, &$complexObj) {
		foreach ($complexObj as $paramName => $value) {
			if (is_object($value)) {
				$plainObj->$paramName = new stdClass();
				$this->makeStandardObj($plainObj->$paramName, $value);
			} else {
				$plainObj->$paramName = $value;
			}
		}
	} 
	
}
